|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.doclinx.ftxml.AppParms
Abstract callback class for passing application specific parameters on
a file-by-file basis. The application extends the class in order to
implement the callback feature allowing addition of parameters to
the indexed file. The callback entry points can also control individual
file exclusion and also abort the entire process.
The functions in this class are called while processing files in
the catAddFile()
method.
sr_f1 parameter definition
Field Summary | |
int |
mode
Mode of operation control bit settings. |
static int |
PC_ADDCAT
mode: Put parameters into catalog (6th auxInfo item) |
static int |
PC_INDEX
mode: Index parameters. |
static int |
PC_PARRAY
mode: C++ ONLY |
static int |
PC_SARRAY
mode: C++ ONLY |
static int |
PC_STRING
mode: String parameters (use sRoot for tag): 'p1="word" p2="wrd wrd"') |
static int |
PC_TAG
mode: Complete XML-like specification: '<tag p1="word" p2="wrd wrd">') |
java.lang.String |
sParms
The parameter string passed back based on current file path |
java.lang.String |
sRoot
The string that is the root object in the context tree (PC_STRING) OR semantic action list if mode bit PC_TAG is used. |
Constructor Summary | |
AppParms()
Constructor with default values for parse parameters. |
Method Summary | |
boolean |
abort()
Callback that permits application to abort processing. |
java.lang.String |
getAltTitle()
Callback function that allows the user to set the altTile. |
abstract boolean |
getParms(java.lang.String filePath)
Set the above parameters(mode, sParms, sRoot) based upon the passed in file name. |
java.lang.String |
getURL()
Callback function that allows the user to set the URL field. |
void |
init(com.doclinx.ftxml.SRC2STF_PARMS sParms,
com.doclinx.ftxml.CatalogManager cm)
Callback function called at beginning of the catAddFile() processing. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int PC_TAG
public static final int PC_STRING
public static final int PC_SARRAY
public static final int PC_PARRAY
public static final int PC_ADDCAT
public static final int PC_INDEX
public java.lang.String sParms
public java.lang.String sRoot
public int mode
PARAMETER CALLBACK Mode Settings PC_TAG - sParms: <TAG "p1='w w w' p2='w w w' ... pn='last'> sRoot: Has semantic action info when using PC_TAG Format: "tag,action;tag,action;....." Allows semantic actions to be set on a document basis (usually for the local user parameter data). PC_STRING - sParms format: "p1='w w w' p2='w w w' ... pn='last'" Note that the value parts can be quoted with (') or (") The sRoot value contains the tag (path) name PC_SARRAY - C++ version ONLY! PC_PARRAY - C++ version ONLY! PC_ADDCAT - If set, then information is saved in catalog PC_INDEX - If set, then information is indexed as part of document
Constructor Detail |
public AppParms()
Method Detail |
public abstract boolean getParms(java.lang.String filePath)
filePath
- Full path name of file currently being processed.
Sample implementation: public boolean getParms(String filePath) { if (filePath == "some name") { sParms = "p1='word word word' p2='x y z' p3...... pn='last'"; sPath = "lroot"; // query example: word in tag "lroot/@p1" mode = PC_STRING | PC_ADDCAT | PC_INDEX; return true; } // process any accepted file names here ... return false; // skip all "unknown files" }
**none
public boolean abort()
**none
public java.lang.String getAltTitle()
**none
public java.lang.String getURL()
**none
public void init(com.doclinx.ftxml.SRC2STF_PARMS sParms, com.doclinx.ftxml.CatalogManager cm)
**none
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |